home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 1 / Meeting Pearls Vol 1 (1994).iso / installed_progs / linux / tools / amiga / gzip-1.1.2.lha / gzip-1.1.2 / vms / gzip.hlp next >
Encoding:
Text File  |  1993-05-29  |  9.3 KB  |  211 lines

  1. 1 GZIP
  2. NAME
  3.      gzip, gunzip, zcat - compress or expand files
  4.  
  5. SYNOPSIS
  6.      gzip [ -cdfhLrtvV19 ] [ name ... ]
  7.      gunzip [ -cfhLrtvV ] [ name ... ]
  8.      zcat [ -hLV ] [ name ... ]
  9.  
  10. 2 DESCRIPTION
  11.      Gzip reduces the size of the named  files  using  Lempel-Ziv
  12.      coding  (LZ77).  Whenever possible, each file is replaced by
  13.      one with the extension .gz, while keeping the same ownership
  14.      modes,  access  and modification times.  (The default exten-
  15.      sion is -gz for VMS, z for MSDOS, OS/2  and  Atari.)  If  no
  16.      files are specified, the standard input is compressed to the
  17.      standard output. If the new file  name  is  too  long,  gzip
  18.      truncates  it  and  keeps  the  original  file  name  in the
  19.      compressed file.  Gzip will only attempt to compress regular
  20.      files.  In particular, it will ignore symbolic links.
  21.  
  22.      Compressed files can be  restored  to  their  original  form
  23.      using gzip -d or gunzip or zcat.
  24.  
  25.      gunzip takes a  list  of  files  on  its  command  line  and
  26.      replaces each file whose name ends with .gz, -gz, .z, -z, _z
  27.      or .Z and which begins with the correct magic number with an
  28.      uncompressed  file  without  the original extension.  gunzip
  29.      also recognizes the special  extensions  .tgz  and  .taz  as
  30.      shorthands for .tar.gz and .tar.Z respectively.
  31.  
  32.      gunzip can currently decompress files created by gzip,  zip,
  33.      compress  or  pack.  The  detection  of  the input format is
  34.      automatic.  When using the first two formats, gunzip  checks
  35.      a  32  bit  CRC.  For  pack,  gunzip checks the uncompressed
  36.      length. The compress format was not designed to  allow  con-
  37.      sistency  checks. However gunzip is sometimes able to detect
  38.      a bad .Z file. If you get an error when uncompressing  a  .Z
  39.      file,  do  not  assume  that  the  .Z file is correct simply
  40.      because the standard uncompress does not complain. This gen-
  41.      erally means that the standard uncompress does not check its
  42.      input, and happily generates garbage output.
  43.  
  44.      Files created by zip can be uncompressed  by  gzip  only  if
  45.      they  have  a  single member compressed with the 'deflation'
  46.      method. This feature is only intended to help conversion  of
  47.      tar.zip  files  to  the  tar.gz format. To extract zip files
  48.      with several members, use unzip instead of gunzip.
  49.  
  50.      zcat is identical to gunzip -c. (On some systems,  zcat  may
  51.      be  installed  as  gzcat  to  preserve  the original link to
  52.      compress.) zcat uncompresses either a list of files  on  the
  53.      command   line   or   its  standard  input  and  writes  the
  54.      uncompressed data on standard output.  zcat will  uncompress
  55.      files that have the correct magic number whether they have a
  56.      .gz suffix or not.
  57.  
  58.      Gzip uses the Lempel-Ziv algorithm used in  zip  and  PKZIP.
  59.      The  amount  of  compression obtained depends on the size of
  60.      the input and the distribution of common substrings.   Typi-
  61.      cally,  text  such  as  source code or English is reduced by
  62.      60-70%.  Compression is  generally  much  better  than  that
  63.      achieved  by  LZW  (as used in compress), Huffman coding (as
  64.      used in pack), or adaptive Huffman coding (compact).
  65.  
  66.      Compression is always performed, even if the compressed file
  67.      is  slightly larger than the original. The worst case expan-
  68.      sion is a few bytes for the gzip file header, plus  5  bytes
  69.      every  32K  block, or an expansion ratio of 0.015% for large
  70.      files. Note that the  actual  number  of  used  disk  blocks
  71.      almost  never increases.  gzip preserves the mode, ownership
  72.      and timestamps of files when compressing or decompressing.
  73.  
  74. 2 OPTIONS
  75.      -c --stdout
  76.           Write output on standard output;  keep  original  files
  77.           unchanged.   If there are several input files, the out-
  78.           put consists of a sequence of independently  compressed
  79.           members.  To obtain better compression, concatenate all
  80.           input files before compressing them.
  81.  
  82.      -d --decompress --uncompress
  83.           Decompress.
  84.  
  85.      -f --force
  86.           Force compression or decompression even if the file has
  87.           multiple   links  or  the  corresponding  file  already
  88.           exists, or if the compressed data is read from or writ-
  89.           ten  to  a  terminal.  If -f is not given, and when not
  90.           running in  the  background,  gzip  prompts  to  verify
  91.           whether an existing file should be overwritten.
  92.  
  93.      -h --help
  94.           Display a help screen and quit.
  95.  
  96.      -L --license
  97.           Display the gzip license.
  98.  
  99.      -q --quiet
  100.           Suppress all warnings.
  101.  
  102.      -r --recurse
  103.           Travel the directory structure recursively. If  any  of
  104.           the  file  names  specified  on  the  command  line are
  105.           directories, gzip will descend into the  directory  and
  106.           compress  all  the  files it finds there (or decompress
  107.           them in the case of gunzip ).
  108.  
  109.      -S -z --suffix -z
  110.           Use suffix -z instead of -gz. Any suffix can be  given,
  111.           but suffixes other than -z and -gz should be avoided to
  112.           avoid confusion when files  are  transferred  to  other
  113.           systems.  Previous versions of gzip used the -z suffix.
  114.           This was changed to avoid a conflict with pack.
  115.  
  116.      -t --test
  117.           Test. Check the compressed file integrity.
  118.  
  119.      -v --verbose
  120.           Verbose. Display the name and percentage reduction  for
  121.           each file compressed.
  122.  
  123.      -V --version
  124.           Version. Display the  version  number  and  compilation
  125.           options then quit.
  126.  
  127.      -# --fast --best
  128.           Regulate the speed of compression using  the  specified
  129.           digit  #,  where  -1  or  --fast  indicates the fastest
  130.           compression method (less compression) and -9 or  --best
  131.           indicates   the  slowest  compression  method  (optimal
  132.           compression).  The default compression level is -5.
  133.  
  134. 2 ENVIRONMENT
  135.      The environment variable GZIP_OPT can hold a set of  default
  136.      options  for  gzip.  These options are interpreted first and
  137.      can be overwritten by explicit command line  parameters. For
  138.      example:
  139.            GZIP_OPT == "-8 -v"
  140.  
  141. 2 SEE ALSO
  142.      compress, zip, unzip
  143.  
  144. 2 DIAGNOSTICS
  145.      Exit status is normally 0; if an error occurs,  exit  status
  146.      is 1. If a warning occurs, exit status is 2.
  147.  
  148.      Usage: gzip [-cdfhLrStvV19] [file ...]
  149.              Invalid options were specified on the command line.
  150.      file: not in gzip format
  151.              The  file  specified  to   gunzip   has   not   been
  152.              compressed.
  153.      file: Corrupt input. Use zcat to recover some data.
  154.              The compressed file has been damaged. The data up to
  155.              the point of failure can be recovered using
  156.                    define /user sys$output file.recover
  157.                    zcat file
  158.      file: compressed with xx bits, can only handle yy bits
  159.              File was compressed (using LZW) by  a  program  that
  160.              could  deal  with more bits than the decompress code
  161.              on this machine.  Recompress  the  file  with  gzip,
  162.              which compresses better and uses less memory.
  163.      file: already has gz suffix -- no change
  164.              The  file  is  assumed  to  be  already  compressed.
  165.              Rename the file and try again.
  166.      file already exists; do you wish to overwrite (y or n)?
  167.              Respond "y" if  you  want  the  output  file  to  be
  168.              replaced; "n" if not.
  169.      gunzip: corrupt input
  170.              A SIGSEGV violation was detected which usually means
  171.              that the input file has been corrupted.
  172.      xx.x%
  173.              Percentage  of  the  input  saved  by   compression.
  174.              (Relevant only for -v.)
  175.      -- not a regular file or directory: ignored
  176.              When the input file is not a regular file or  direc-
  177.              tory, it is left unaltered.
  178.  
  179. 2 CAVEATS
  180.      On VMS:
  181.      - upper case options need quotes: gzip "-V".
  182.      - restoration of timestamps and version numbers is not supported
  183.      - If a compressed file already exists, gzip -f overwrites it, it
  184.        does not create a new version.
  185.      - multi-part gzip files are not supported.
  186.      - gunzip does not preserve the input file format. You can use a
  187.        separate utility to restore the original format.
  188.      - gunzip and zcat can be used only if you have created the
  189.        links to gzip as documented in makegzip.com.  Otherwise
  190.        you must use explicit parameters ("gzip -c" or "gzip -dc").
  191.  
  192.      When writing compressed data to  a  tape,  it  is  generally
  193.      necessary  to pad the output with zeroes up to a block boun-
  194.      dary. When the data is read and the whole block is passed to
  195.      gunzip for decompression, gunzip detects that there is extra
  196.      trailing garbage after the compressed data and emits a warn-
  197.      ing  by  default.  You  have  to  use  the --quiet option to
  198.      suppress the warning. This option can be  set  in  the  GZIP
  199.      environment variable as in:
  200.          GZIP == "-q"
  201.          tar xfz /dev/rmt/datn
  202.  
  203.      In the above example, gzip is invoked implicitly by  the  -z
  204.      option  of  GNU  tar. Make sure that the same block size (-b
  205.      option of tar) is used for reading  and  writing  compressed
  206.      data on tapes.
  207.  
  208. 2 BUGS
  209.      On VMS, files in VFC record format are not correctly handled by
  210.      the C runtime library (the linefeed character is suppressed).
  211.